<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Karamelo: Cylinder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="karamelodoxy.css" rel="stylesheet" type="text/css">
<!--  -->
<script type="text/javascript" src="karamelo_navtree_hacks.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.karamelo.org"><img alt="Logo" src="Karamelo_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="http://www.karamelo.org">Karamelo</a>
   &#160;<span id="projectnumber">714599e9</span>
   </div>
   <div id="projectbrief">Parallel Material Point Method Simulator</div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classCylinder.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="classCylinder-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Cylinder Class Reference<div class="ingroups"><a class="el" href="group__region.html">region</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h1><a class="anchor" id="Syntax"></a>
Syntax</h1>
<div class="fragment"><div class="line">region(region-ID, cylinder, axis, c1, c2, R, lo, hi) <span class="preprocessor">#in 3D</span></div><div class="line"><span class="preprocessor">region(region-ID, cylinder, c1, c2, R, lo, hi) #in 2D</span></div></div><!-- fragment --><ul>
<li>
region-ID: name of the region to be created. </li>
<li>
axis: direction of the cylinder's axis: 'x', 'y' or 'z'. </li>
<li>
c1, c2: coordinates of the cylinder's axis in the other direction. </li>
<li>
R: radius of the base of the cylinder. </li>
<li>
lo, hi: lower and upper limits of the cylinder in the direction of the axis. </li>
</ul>
<h1><a class="anchor" id="Examples"></a>
Examples</h1>
<div class="fragment"><div class="line">region(rCyl, cylinder, x, 0, 0, 10, -1, 1)</div></div><!-- fragment --><p> Defines a cylinder called 'rCyl' of radius 10 with axis x passing through the origin, i.e. (0,0) and spanning between x=-1 to x=+1.</p>
<h1><a class="anchor" id="Description"></a>
Description</h1>
<p>This command defines a cylindrical region of space. It is usually used by groups to find what nodes and/or particles lie within a specific region of space. A region does not select nodes or particles.</p>
<h1><a class="anchor" id="Class"></a>
Class description</h1>
</div><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Cylinder:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCylinder__inherit__graph.png" border="0" usemap="#Cylinder_inherit__map" alt="Inheritance graph"/></div>
<map name="Cylinder_inherit__map" id="Cylinder_inherit__map">
<area shape="rect" id="node2" href="classRegion.html" title="{Region\n|+ id\l+ interior\l|+ init()\l+ inside()\l+ limits()\l+ match()\l+ options()\l+ Region()\l+ ~Region()\l}" alt="" coords="9,336,100,516"/>
<area shape="rect" id="node3" href="classPointers.html" title="{Pointers\n|# domain\l# error\l# group\l# infile\l# input\l# logfile\l# material\l# memory\l# modify\l# mpm\l# output\l# universe\l# update\l# wlogfile\l|+ Pointers()\l+ ~Pointers()\l}" alt="" coords="5,5,104,288"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_classRegion"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classRegion')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classRegion.html">Region</a></td></tr>
<tr class="memitem:a6cb3a6cc6e5078ccbb0ee48cc3440ee5 inherit pub_attribs_classRegion"><td class="memItemLeft" align="right" valign="top"><a id="a6cb3a6cc6e5078ccbb0ee48cc3440ee5"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegion.html#a6cb3a6cc6e5078ccbb0ee48cc3440ee5">id</a></td></tr>
<tr class="memdesc:a6cb3a6cc6e5078ccbb0ee48cc3440ee5 inherit pub_attribs_classRegion"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classRegion.html">Region</a> identification string. <br /></td></tr>
<tr class="separator:a6cb3a6cc6e5078ccbb0ee48cc3440ee5 inherit pub_attribs_classRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a992ea985f0eb960f3a4aa3fe63e821ec inherit pub_attribs_classRegion"><td class="memItemLeft" align="right" valign="top"><a id="a992ea985f0eb960f3a4aa3fe63e821ec"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRegion.html#a992ea985f0eb960f3a4aa3fe63e821ec">interior</a></td></tr>
<tr class="memdesc:a992ea985f0eb960f3a4aa3fe63e821ec inherit pub_attribs_classRegion"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 for interior, 0 for exterior <br /></td></tr>
<tr class="separator:a992ea985f0eb960f3a4aa3fe63e821ec inherit pub_attribs_classRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="region__cylinder_8h_source.html">region_cylinder.h</a></li>
<li>region_cylinder.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classCylinder.html">Cylinder</a></li>
    <li class="footer">Generated on Tue Jul 7 2020 22:31:23 for Karamelo by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
<!-- Matomo -->
<script type="text/javascript">
  var _paq = _paq || [];
  /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="//stats.sylphide-consulting.com/matomo/";
    _paq.push(['setTrackerUrl', u+'piwik.php']);
    _paq.push(['setSiteId', '20']);
    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
    g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<noscript><p><img src="//stats.sylphide-consulting.com/matomo/piwik.php?idsite=20&rec=1" style="border:0;" alt="" /></p></noscript>
<!-- End Matomo Code -->
</body>
</html>
